Skip to content

docs(ai): connect-mcp — record what a first real connection actually hits - #16474

Merged
os-zhuang merged 1 commit into
mainfrom
claude/platform-mcp-capability-55dea7
Sep 7, 2026
Merged

docs(ai): connect-mcp — record what a first real connection actually hits#16474
os-zhuang merged 1 commit into
mainfrom
claude/platform-mcp-capability-55dea7

Conversation

@baozhoutao

Copy link
Copy Markdown
Contributor

Summary

Walked content/docs/ai/connect-mcp.mdx against a live app (Claude Code 2.1 + @objectstack/mcp 17.2, HotCRM sample data) and wrote down the four places a first attempt stalls that the page did not cover. Docs-only; publishes nothing.

What changed (one page)

  • OAuth track — after claude mcp add, claude mcp list / claude mcp get report ✘ Failed to connect until /mcpAuthenticate is completed in a new session. The health probe is answered 401; the setup is not broken. A session already running when the server was added never picks it up.
  • API-key track — where the key is minted (Setup → Connect an Agent, its console route, the Create key button at the bottom, shown once with a ready x-api-key: line, revoked under Setup → API keys); that a keyed registration shows ✔ Connected with no login step; that claude mcp add is local scope by default and -s user makes it global.
  • Verify — an anonymous curl that must return 401, then a keyed walk through initializetools/listtools/call query_records, with the two gotchas that cost a retry: the argument is objectName, and its value is the API name from list_objects (crm_opportunity, not opportunityObject 'opportunity' not found).
  • Troubleshooting — four rows for the symptoms above (pre-auth Failed to connect, ConnectionRefused when the app is down, server missing from a running session / wrong scope, wrong object name).

Verification

  • check-docs-single-h1, check-docs-redirects, check-docs-image-tag all pass.
  • Every /docs/... link on the page resolves to an existing page.
  • The curl transcripts in the Verify section are the actual responses from the live run (11 tools listed, query_records on crm_opportunity returning total: 23).

🤖 Generated with Claude Code

@baozhoutao baozhoutao added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Sep 7, 2026
@github-actions github-actions Bot added size/s documentation Improvements or additions to documentation labels Sep 7, 2026
…hits

Walked the page against a live app (Claude Code 2.1 + `@objectstack/mcp` 17.2)
and wrote down the four places a first attempt stalls that the page did not
cover:

- OAuth track: after `claude mcp add`, `claude mcp list` reports "Failed to
  connect" until `/mcp` → Authenticate is done in a NEW session — the health
  probe is answered 401, not a broken setup. A running session never picks
  the server up.
- API-key track: where the key is minted (Setup → Connect an Agent, page
  route, button at the bottom, shown once with a ready `x-api-key:` line),
  that a keyed registration shows "Connected" with no login, and that
  `claude mcp add` is local-scope by default (`-s user` for everywhere).
- Verify: an anonymous curl that must return 401, and a keyed curl walk
  through initialize → tools/list → query_records, with the two gotchas that
  cost a retry — the argument is `objectName`, and its value is the API name
  from `list_objects` (`crm_opportunity`, not `opportunity`).
- Troubleshooting: four rows for the above symptoms.

Docs-only; publishes nothing.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@os-zhuang
os-zhuang added this pull request to the merge queue Sep 7, 2026
Merged via the queue into main with commit ab47712 Sep 7, 2026
36 checks passed
@os-zhuang
os-zhuang deleted the claude/platform-mcp-capability-55dea7 branch September 7, 2026 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/s skip-changeset PR has no user-facing published change; bypasses the changeset gate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants